LTE IoT 19 Click Driver

API for configuring and manipulating LTE IoT 19 Click driver. More...

Topics
	LTE IoT 19 Device Settings
	Settings for registers of LTE IoT 19 Click driver.
	LTE IoT 19 MikroBUS Map
	MikroBUS pin mapping of LTE IoT 19 Click driver.

Functions
void	lteiot19_cfg_setup (lteiot19_cfg_t *cfg)
	LTE IoT 19 configuration object setup function.
err_t	lteiot19_init (lteiot19_t *ctx, lteiot19_cfg_t *cfg)
	LTE IoT 19 initialization function.
err_t	lteiot19_generic_write (lteiot19_t *ctx, uint8_t *data_in, uint16_t len)
	LTE IoT 19 data writing function.
err_t	lteiot19_generic_read (lteiot19_t *ctx, uint8_t *data_out, uint16_t len)
	LTE IoT 19 data reading function.
void	lteiot19_set_wup_pin (lteiot19_t *ctx, uint8_t state)
	LTE IoT 19 set WUP pin function.
void	lteiot19_set_rst_pin (lteiot19_t *ctx, uint8_t state)
	LTE IoT 19 set RST pin function.
void	lteiot19_set_rts_pin (lteiot19_t *ctx, uint8_t state)
	LTE IoT 19 set RTS pin function.
uint8_t	lteiot19_get_ring_pin (lteiot19_t *ctx)
	LTE IoT 19 get RING pin function.
uint8_t	lteiot19_get_rts_pin (lteiot19_t *ctx)
	LTE IoT 19 get CTS pin function.
void	lteiot19_set_power_state (lteiot19_t *ctx, uint8_t state)
	LTE IoT 19 set power state function.
void	lteiot19_cmd_run (lteiot19_t *ctx, uint8_t *cmd)
	LTE IoT 19 cmd run function.
void	lteiot19_cmd_set (lteiot19_t *ctx, uint8_t *cmd, uint8_t *value)
	LTE IoT 19 cmd set function.
void	lteiot19_cmd_get (lteiot19_t *ctx, uint8_t *cmd)
	LTE IoT 19 cmd get function.
void	lteiot19_cmd_help (lteiot19_t *ctx, uint8_t *cmd)
	LTE IoT 19 cmd help function.
void	lteiot19_set_sim_apn (lteiot19_t *ctx, uint8_t *sim_apn)
	LTE IoT 19 set sim card APN function.
void	lteiot19_send_sms_text (lteiot19_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
	LTE IoT 19 send SMS in text mode function.
err_t	lteiot19_send_sms_pdu (lteiot19_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
	LTE IoT 19 send SMS in PDU mode function.

Detailed Description

API for configuring and manipulating LTE IoT 19 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

lteiot19_cfg_setup()

void lteiot19_cfg_setup

(

lteiot19_cfg_t *

cfg

)

LTE IoT 19 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See lteiot19_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

lteiot19_cmd_get()

void lteiot19_cmd_get	(	lteiot19_t *	ctx,
		uint8_t *	cmd )

LTE IoT 19 cmd get function.

This function is used to get the value of a given command from the Click module.

Parameters

[in]	ctx	: Click context object. See lteiot19_t object definition for detailed explanation.
[in]	cmd	: Command string.

Returns

None.

Note

None.

lteiot19_cmd_help()

void lteiot19_cmd_help	(	lteiot19_t *	ctx,
		uint8_t *	cmd )

LTE IoT 19 cmd help function.

This function provides a short description of the given command of the Click module.

Parameters

[in]	ctx	: Click context object. See lteiot19_t object definition for detailed explanation.
[in]	cmd	: Command string.

Returns

None.

Note

None.

lteiot19_cmd_run()

void lteiot19_cmd_run	(	lteiot19_t *	ctx,
		uint8_t *	cmd )

LTE IoT 19 cmd run function.

This function sends a specified command to the Click module.

Parameters

[in]	ctx	: Click context object. See lteiot19_t object definition for detailed explanation.
[in]	cmd	: Command string.

Returns

None.

Note

None.

lteiot19_cmd_set()

void lteiot19_cmd_set	(	lteiot19_t *	ctx,
		uint8_t *	cmd,
		uint8_t *	value )

LTE IoT 19 cmd set function.

This function sets a value to a specified command of the Click module.

Parameters

[in]	ctx	: Click context object. See lteiot19_t object definition for detailed explanation.
[in]	cmd	: Command string.
[in]	value	: Value string.

Returns

None.

Note

None.

lteiot19_generic_read()

err_t lteiot19_generic_read	(	lteiot19_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

LTE IoT 19 data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See lteiot19_t object definition for detailed explanation.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

• >0 - Number of data bytes read,
• <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.

Note

None.

lteiot19_generic_write()

err_t lteiot19_generic_write	(	lteiot19_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

LTE IoT 19 data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See lteiot19_t object definition for detailed explanation.
[in]	data_in	: Data buffer for sending.
[in]	len	: Number of bytes for sending.

Returns

• >=0 - Success,
• <0 - Error. See #err_t definition for detailed explanation.

Note

None.

lteiot19_get_ring_pin()

uint8_t lteiot19_get_ring_pin

(

lteiot19_t *

ctx

)

LTE IoT 19 get RING pin function.

This function returns the ring indication (RING) pin logic state.

Parameters

[in]

ctx

: Click context object. See lteiot19_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

lteiot19_get_rts_pin()

uint8_t lteiot19_get_rts_pin

(

lteiot19_t *

ctx

)

LTE IoT 19 get CTS pin function.

This function returns the clear to send (CTS) pin logic state.

Parameters

[in]

ctx

: Click context object. See lteiot19_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

lteiot19_init()

err_t lteiot19_init	(	lteiot19_t *	ctx,
		lteiot19_cfg_t *	cfg )

LTE IoT 19 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See lteiot19_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See lteiot19_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

lteiot19_send_sms_pdu()

err_t lteiot19_send_sms_pdu	(	lteiot19_t *	ctx,
		uint8_t *	service_center_number,
		uint8_t *	phone_number,
		uint8_t *	sms_text )

LTE IoT 19 send SMS in PDU mode function.

This function sends text message to a phone number in PDU mode.

Parameters

[in]	ctx	: Click context object. See lteiot19_t object definition for detailed explanation.
[in]	service_center_number	: SMSC of the SIM card.
[in]	phone_number	: Phone number to message.
[in]	sms_text	: Message to be sent.

Returns

• >=0 - Success,
• <0 - Error. See #err_t definition for detailed explanation.

Note

None.

lteiot19_send_sms_text()

void lteiot19_send_sms_text	(	lteiot19_t *	ctx,
		uint8_t *	phone_number,
		uint8_t *	sms_text )

LTE IoT 19 send SMS in text mode function.

This function sends text message to a phone number.

Parameters

[in]	ctx	: Click context object. See lteiot19_t object definition for detailed explanation.
[in]	phone_number	: Phone number to message.
[in]	sms_text	: Message to be sent.

Returns

Nothing.

Note

None.

lteiot19_set_power_state()

void lteiot19_set_power_state	(	lteiot19_t *	ctx,
		uint8_t	state )

LTE IoT 19 set power state function.

This function sets a desired power state by toggling the RST and WUP pins.

Parameters

[in]	ctx	: Click context object. See lteiot19_t object definition for detailed explanation.
[in]	state	: 0 - Power OFF, 1 - Power ON, 2 - Reset. 3 - Wake-up.

Returns

None.

Note

None.

lteiot19_set_rst_pin()

void lteiot19_set_rst_pin	(	lteiot19_t *	ctx,
		uint8_t	state )

LTE IoT 19 set RST pin function.

This function sets the reset (RST) pin logic state.

Parameters

[in]	ctx	: Click context object. See lteiot19_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns

None.

Note

None.

lteiot19_set_rts_pin()

void lteiot19_set_rts_pin	(	lteiot19_t *	ctx,
		uint8_t	state )

LTE IoT 19 set RTS pin function.

This function sets the request to send (RTS) pin logic state.

Parameters

[in]	ctx	: Click context object. See lteiot19_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns

None.

Note

None.

lteiot19_set_sim_apn()

void lteiot19_set_sim_apn	(	lteiot19_t *	ctx,
		uint8_t *	sim_apn )

LTE IoT 19 set sim card APN function.

This function sets APN for sim card.

Parameters

[in]	ctx	: Click context object. See lteiot19_t object definition for detailed explanation.
[in]	sim_apn	: SIM card APN.

Returns

Nothing.

Note

None.

lteiot19_set_wup_pin()

void lteiot19_set_wup_pin	(	lteiot19_t *	ctx,
		uint8_t	state )

LTE IoT 19 set WUP pin function.

This function sets the wakeup pin logic state.

Parameters

[in]	ctx	: Click context object. See lteiot19_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns

None.

Note

None.